Switch streaming engine worker harness based on job settings - #35901
Conversation
![gemini-code-assist[bot]](https://avatars.githubusercontent.com/in/956858?s=60&v=4){kind=small}
There was a problem hiding this comment.
Summary of Changes
Hello @parveensania, I'm Gemini Code Assist1! I'm currently reviewing this pull request and will post my feedback shortly. In the meantime, here's a summary to help you and other reviewers quickly get up to speed!
This pull request introduces the capability for the Dataflow streaming worker to dynamically switch its underlying processing engine harness (directpath vs. cloudpath) based on real-time job configuration updates. This enhancement allows for greater flexibility and adaptability in how streaming jobs connect to the Windmill service, optimizing performance and resource utilization by selecting the most appropriate connectivity type. It also ensures that associated status monitoring components are correctly re-initialized during these transitions.
Highlights
- Dynamic Worker Harness Switching: The core functionality introduced is the ability for the
StreamingDataflowWorkerto dynamically switch betweenFanOutStreamingEngineWorkerHarness(for directpath connectivity) andSingleSourceWorkerHarness(for cloudpath connectivity). - Configuration-Driven Connectivity: A new
ConnectivityTypeenum has been added towindmill.protoand integrated intoUserWorkerRunnerV1Settings, allowing the worker harness type to be configured and changed based on job settings. - Status Page Restart on Harness Change: Upon a change in the worker harness type, the
StreamingWorkerStatusPagesare now gracefully stopped and then restarted with updated status providers to ensure they reflect the current operational state. - Refactored Harness Creation Logic: The logic for creating the different worker harnesses has been extracted into dedicated private methods within
StreamingDataflowWorker, improving code organization and reusability during the switching process. - Experimental Option for Direct Path Control: An experimental option
enable_windmill_service_direct_path=falsehas been added toDataflowStreamingPipelineOptions, providing a way to explicitly disable direct path connectivity. - Concurrency Handling for Harness Switching: The
streamingWorkerHarnessis now managed by anAtomicReference, and a dedicatedharnessSwitchExecutoris used to handle the asynchronous switching of harnesses, ensuring thread safety and proper lifecycle management. - New Test Coverage for Dynamic Switching: Comprehensive test coverage has been added in
StreamingDataflowWorkerTestto verify the seamless dynamic switching between the different worker harness types.
Using Gemini Code Assist
The full guide for Gemini Code Assist can be found on our documentation page, here are some quick tips.
Invoking Gemini
You can request assistance from Gemini at any point in your pull request via creating an issue comment (i.e. comment on the pull request page) using either /gemini <command> or @gemini-code-assist <command>. Below is a summary of the supported commands.
| Feature | Command | Description |
|---|---|---|
| Code Review | /gemini review |
Performs a code review for the current pull request in its current state. |
| Pull Request Summary | /gemini summary |
Provides a summary of the current pull request in its current state. |
| Comment | @gemini-code-assist | Responds in comments when explicitly tagged, both in issue comments and review comments. |
| Help | /gemini help |
Displays a list of available commands. |
Customization
To customize Gemini Code Assist for GitHub experience, repository maintainers can create a configuration file and/or provide a custom code review style guide (such as PEP-8 for Python) by creating and adding files to a .gemini/ folder in the base of the repository. Detailed instructions can be found here.
Limitations & Feedback
Gemini Code Assist may make mistakes. Please leave feedback on any instances where its feedback is incorrect or counter productive. You can react with 👍 and 👎 on @gemini-code-assist comments. If you're interested in giving your feedback about your experience with Gemini Code Assist for Github and other Google products, sign up here.
You can also get AI-powered code generation, chat, as well as code reviews directly in the IDE at no cost with the Gemini Code Assist IDE Extension.
Footnotes
-
Review the Privacy Notices, Generative AI Prohibited Use Policy, Terms of Service, and learn how to configure Gemini Code Assist in GitHub here. Gemini can make mistakes, so double check it and use code with caution. ↩
|
Checks are failing. Will not request review until checks are succeeding. If you'd like to override that behavior, comment |
|
Assigning reviewers: R: @chamikaramj added as fallback since no labels match configuration Note: If you would like to opt out of this review, comment Available commands:
The PR bot will only process comments in the main thread (not review comments). |
|
Reminder, please take a look at this pr: @chamikaramj |
|
Hey @arunpandianp, can you give this another pass? |
|
@parveensania can you close or address the remaining open comments? The comment on mocks need to be addressed, I think others can be resolved. |
|
Reminder, please take a look at this pr: @chamikaramj |
|
Assigning new set of reviewers because Pr has gone too long without review. If you would like to opt out of this review, comment R: @chamikaramj added as fallback since no labels match configuration Available commands:
|
8782424 to
1c1922c
Compare
|
Run Java Precommit |
1 similar comment
|
Run Java Precommit |
|
Please check the failed workflows. |
…d its dependencies
…treamingEngineWorkerHarness
a84f7c2 to
7f56472
Compare
4 participants
Based on Streaming engine global config which is pulled periodically, switch the type to worker harness to use. This is to switch between directpath (FanOutStreamingEngineWorkerHarness) and cloudpath (SingleSourceWorkerHarness) connectivity type. The StreamingWorkerStatusPages are also restarted with new status providers whenever the harness type changes.
Thank you for your contribution! Follow this checklist to help us incorporate your contribution quickly and easily:
addresses #123), if applicable. This will automatically add a link to the pull request in the issue. If you would like the issue to automatically close on merging the pull request, commentfixes #<ISSUE NUMBER>instead.CHANGES.mdwith noteworthy changes.See the Contributor Guide for more tips on how to make review process smoother.
To check the build health, please visit https://github.com/apache/beam/blob/master/.test-infra/BUILD_STATUS.md
GitHub Actions Tests Status (on master branch)
See CI.md for more information about GitHub Actions CI or the workflows README to see a list of phrases to trigger workflows.